Docs
put https://api.pix.iugu.com/api/v2/webhook/{chave}

Configurar o Webhook Pix.

Endpoint para configuração do serviço de notificações acerca de Pix recebidos. Somente Pix associados a um txid serão notificados.

Sem ações implementadas definidas

Request

Path variables

chave

Required

Type: string

Headers

workspace_id

Required

Type: string

Identificador do workspace

Ex: 4fHECmQtLdROI4fDLWMiLd

Body Required

Content Type: application/json

webhookUrl

Required

String

Ex: https://pix.example.com/api/webhook/

Example
1
2
3
{
  "webhookUrl": "https://pix.example.com/api/webhook/"
}

Response

200

Webhook para notificações acerca de Pix recebidos associados a um txid.

400

Requisição com formato inválido.

type
String

URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.

Ex: https://pix.bcb.gov.br/api/v2/error/NaoEncontrado

title
String

Descrição resumida do problema.

Ex: Not found

status
Integer

Código HTTP do status retornado.

Ex: 404

detail
String

Descrição completa do problema.

correlationId
String

Identificador de correlação do problema para fins de suporte

violacoes
Array of objects

razao
String

Descrição do erro

Ex: Valor da cobrança não pode ser 0.00

propriedade
String

Nome da propriedade

Ex: cob.chave

valor
String

Valor da propriedade

Ex: 061996671234

403

Requisição de participante autenticado que viola alguma regra de autorização.

type
String

URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.

Ex: https://pix.bcb.gov.br/api/v2/error/NaoEncontrado

title
String

Descrição resumida do problema.

Ex: Not found

status
Integer

Código HTTP do status retornado.

Ex: 404

detail
String

Descrição completa do problema.

correlationId
String

Identificador de correlação do problema para fins de suporte

violacoes
Array of objects

razao
String

Descrição do erro

Ex: Valor da cobrança não pode ser 0.00

propriedade
String

Nome da propriedade

Ex: cob.chave

valor
String

Valor da propriedade

Ex: 061996671234

404

Recurso solicitado não foi encontrado.

type
String

URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.

Ex: https://pix.bcb.gov.br/api/v2/error/NaoEncontrado

title
String

Descrição resumida do problema.

Ex: Not found

status
Integer

Código HTTP do status retornado.

Ex: 404

detail
String

Descrição completa do problema.

correlationId
String

Identificador de correlação do problema para fins de suporte

violacoes
Array of objects

razao
String

Descrição do erro

Ex: Valor da cobrança não pode ser 0.00

propriedade
String

Nome da propriedade

Ex: cob.chave

valor
String

Valor da propriedade

Ex: 061996671234

503

Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento.

type
String

URI de referência que identifica o tipo de problema. De acordo com a RFC 7807.

Ex: https://pix.bcb.gov.br/api/v2/error/NaoEncontrado

title
String

Descrição resumida do problema.

Ex: Not found

status
Integer

Código HTTP do status retornado.

Ex: 404

detail
String

Descrição completa do problema.

correlationId
String

Identificador de correlação do problema para fins de suporte

violacoes
Array of objects

razao
String

Descrição do erro

Ex: Valor da cobrança não pode ser 0.00

propriedade
String

Nome da propriedade

Ex: cob.chave

valor
String

Valor da propriedade

Ex: 061996671234